메인 콘텐츠로 건너뛰기
GET
/
users
Get all users
curl --request GET \
  --url https://your_a2_service/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "budget": 123,
    "campaign_count": 1,
    "creative_count": 1,
    "credit": 123,
    "email": "jsmith@example.com",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "is_superuser": true,
    "is_verified": true,
    "permissions": {},
    "placement_count": 1,
    "preferences": {
      "etc": {},
      "notification_methods": {},
      "notification_methods_data": {},
      "notifications": {}
    },
    "role": "advertiser",
    "name": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.aiderx.io/llms.txt

Use this file to discover all available pages before exploring further.

인증

​
Authorization
string
header
필수

The access token received from the authorization server in the OAuth 2.0 flow.

쿼리 매개변수

​
id
string | null
​
role
enum<string> | null

유저 역할

사용 가능한 옵션:
advertiser,
retailer,
admin

응답

Successful Response

​
budget
number
필수

사용자가 현재 이용 가능한 전체 예산

​
campaign_count
integer
필수

사용자가 소유한 캠페인 수

필수 범위: x >= 0
​
creative_count
integer
필수

사용자가 소유한 소재 수

필수 범위: x >= 0
​
credit
number
필수

사용자가 현재 이용 가능한 전체 크레딧

​
email
string<email>
필수

유저 이메일

​
id
string<uuid>
필수

유저 id

​
is_active
boolean
필수

사용자 활성 상태 여부

​
is_superuser
boolean
필수

사용자 관리자 여부

​
is_verified
boolean
필수

사용자 이메일 인증 여부

​
permissions
Permissions · object
필수

사용자의 권한 정보

예시:
{}
{
  "admin": [],
  "advertiser": ["permission"],
  "analytic": ["campaign"],
  "audience": [],
  "audience_attribute": ["r"],
  "audience_segment": ["r", "w"],
  "campaign": ["r", "w"],
  "creative": ["r", "w"],
  "placement": ["r"],
  "retailer": []
}
{
  "admin": ["list_advertisers", "budget"],
  "advertiser": [],
  "analytic": ["placement"],
  "audience": ["r"],
  "audience_attribute": ["r", "w"],
  "audience_segment": ["r", "w"],
  "campaign": ["r"],
  "creative": ["r", "w"],
  "placement": ["r", "w"],
  "retailer": ["approval", "permission"]
}
​
placement_count
integer
필수

사용자가 소유한 지면 수

필수 범위: x >= 0
​
preferences
UserPreferences · object
필수

사용자 설정 정보

​
role
enum<string>
필수

유저 역할

사용 가능한 옵션:
advertiser,
retailer,
admin
​
name
string | null

사용자 이름